package com.test.controller;

import com.mybatisflex.core.paginate.Page;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.beans.factory.annotation.Autowired;
import com.test.entity.SysNoticeDO;
import com.test.service.SysNoticeService;
import org.springframework.web.bind.annotation.RestController;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import java.util.List;

/**
 * 通知公告表 控制层。
 *
 * @author mkj
 * @since 2024-07-20
 */
@RestController
@Tag(name = "通知公告表接口")
@RequestMapping("/sysNoticeDO")
public class SysNoticeController {

    @Autowired
    private SysNoticeService sysNoticeService;

    /**
     * 添加通知公告表。
     *
     * @param sysNoticeDO 通知公告表
     * @return {@code true} 添加成功，{@code false} 添加失败
     */
    @PostMapping("save")
    @Operation(description="保存通知公告表")
    public boolean save(@RequestBody @Parameter(description="通知公告表")SysNoticeDO sysNoticeDO) {
        return sysNoticeService.save(sysNoticeDO);
    }

    /**
     * 根据主键删除通知公告表。
     *
     * @param id 主键
     * @return {@code true} 删除成功，{@code false} 删除失败
     */
    @DeleteMapping("remove/{id}")
    @Operation(description="根据主键通知公告表")
    public boolean remove(@PathVariable @Parameter(description="通知公告表主键")Long id) {
        return sysNoticeService.removeById(id);
    }

    /**
     * 根据主键更新通知公告表。
     *
     * @param sysNoticeDO 通知公告表
     * @return {@code true} 更新成功，{@code false} 更新失败
     */
    @PutMapping("update")
    @Operation(description="根据主键更新通知公告表")
    public boolean update(@RequestBody @Parameter(description="通知公告表主键")SysNoticeDO sysNoticeDO) {
        return sysNoticeService.updateById(sysNoticeDO);
    }

    /**
     * 查询所有通知公告表。
     *
     * @return 所有数据
     */
    @GetMapping("list")
    @Operation(description="查询所有通知公告表")
    public List<SysNoticeDO> list() {
        return sysNoticeService.list();
    }

    /**
     * 根据通知公告表主键获取详细信息。
     *
     * @param id 通知公告表主键
     * @return 通知公告表详情
     */
    @GetMapping("getInfo/{id}")
    @Operation(description="根据主键获取通知公告表")
    public SysNoticeDO getInfo(@PathVariable Long id) {
        return sysNoticeService.getById(id);
    }

    /**
     * 分页查询通知公告表。
     *
     * @param page 分页对象
     * @return 分页对象
     */
    @GetMapping("page")
    @Operation(description="分页查询通知公告表")
    public Page<SysNoticeDO> page(@Parameter(description="分页信息")Page<SysNoticeDO> page) {
        return sysNoticeService.page(page);
    }

}
